/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2014-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.grizzly.sni;

import java.net.InetSocketAddress;
import org.glassfish.grizzly.Connection;

/**
 * The client-side SNI config resolver, which could be used to customize
 * SNI host name sent from client to server.
 * 
 * By default the host name is based on {@link Connection#getPeerAddress()} value,
 * particularly for TCP connections the default value will be based on
 * {@link InetSocketAddress#getHostString()}. But <code>SNIClientConfigResolver</code>
 * allows you to customize the default host name value.
 * 
 * @author Alexey Stashok
 */
public interface SNIClientConfigResolver {

    /**
     * Returns {@link SNIConfig} for the new {@link Connection}, <code>null</code>
     * value means no SNI information will be sent.
     * 
     * The {@link SNIConfig} could be created like:
     * 
     * <pre>
     * {@code
     *      SNIConfig.clientConfigBuilder()
     *               .host("myhost.com")
     *               .sslEngineConfigurator(myHostSSLEngineConfigurator)
     *               .build();
     * }
     * </pre>
     * 
     * @param connection
     * @return {@link SNIConfig} for the new {@link Connection}, <code>null</code>
     * value means no SNI information will be sent
     */
    SNIConfig resolve(Connection connection);
}
